home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / VGB.ZIP / VGB-DOS.TXT < prev   
Text File  |  1996-07-18  |  10KB  |  211 lines
  1.                   ******* Virtual GameBoy MS-DOS *******
  2.                   The Portable Nintendo GameBoy Emulator
  3.                                version 0.8b1
  4.                                      
  5.         Core emulator code copyright (C) 1995,1996  Marat Fayzullin
  6.               MS-DOS port copyright (C) 1996  Marcel de Kogel
  7.                                      
  8.                GameBoy is a registered trademark of Nintendo.
  9.                  MS-DOS is a trademark of Microsoft Corp.
  10.  
  11. Note: VGB-DOS requires the presence of a DPMI server. If you don't run the
  12. program under a DPMI-hosted environment (Windows, OS/2, QPMI, ...), put
  13. the file CSDPMI.EXE included in CWSDPMI.ZIP somewhere in your path.
  14.  
  15. Hardware Requirements
  16. =====================
  17. A 486DX-33 (486DX2-66 recommended)
  18. A VGA compatible video card
  19. Adlib/Adlib Gold/SBPro/SB16 and joystick supported
  20.  
  21. Files included in VGB-DOS.ZIP
  22. ==============================
  23. VGB-DOS.EXE    The emulator
  24. VGB-DOS.TXT    This file
  25. VGB-DOS.GIF    A GIF file containing the title screen. You can replace
  26.                this with your own. Make sure the file is in 256-color,
  27.                320x200, non-interlaced GIF87A format. The first 64 colors
  28.                are reserved for use by the emulator
  29. KEYS.EXE       Small utility to alter the key mappings
  30. CWSDMI.ZIP     A DPMI server required by VGB-DOS.EXE
  31. Some utilities for use with VGB MS-DOS can be found on the VGB MS-DOS
  32. distribution site at http://www.komkon.org/~dekogel/vgb.html
  33. More information about VGB and GameBoy in general can be found on the VGB
  34. distibution site at http://www.freeflight.com/fms/VGB
  35.  
  36. Default Key Mappings
  37. ====================
  38. Cursor Keys  -  Movement
  39. Left Alt     -  Button A
  40. Left Ctrl    -  Button B
  41. Left Shift   -  Start
  42. Z            -  Select
  43.  
  44. Special Keys
  45. ============
  46. F1-F4        -  Toggle sound channels 1-4 on/off
  47. F5           -  Toggle sound on/off
  48. F8           -  Pause & Blank screen
  49. F9           -  Pause
  50. F11          -  Decrease volume. Volume control only works on SBPro and
  51.                 SB16 compatible sound cards
  52. F12          -  Increase volume
  53. Both Alts +  -  Reset GameBoy
  54. Both Ctrls
  55. ESC/F10      -  Quit emulator
  56.  
  57. Command line options
  58. ====================
  59. -help                          Print a help page describing all available
  60.                                command line options
  61. -ifreq <frequency>             Select interrupt frequency [60]
  62.                                If you want your games to run faster,
  63.                                increase the interrupt frequency. If you
  64.                                want them to run slower, decrease it. Use -
  65.                                ifreq 0 to disable sync
  66. -verbose <level>               Select debugging messages [1]
  67.                                0 - Silent           1 - Startup messages
  68.                                2 - Illegal writes   4 - Illegal CPU ops
  69.                                8 - Bank switching
  70. -vperiod <period>              Set VBlank interrupts period [69905 cycles]
  71. -uperiod <period>              Number of interrupts per screen update [0]
  72.                                Selecting 0 will enable real-time refresh
  73.                                checking. If emulation is chunky, try -
  74.                                uperiod 2 or -uperiod 3
  75. -cheat <GG code>               Activate GameGenie cheat [none]
  76. -delay/-nodelay                Delay/Don't delay screen refresh [-delay]
  77. -crc/-nocrc                    Check/Don't check cartridge CRC [-crc]
  78. -video <mode>                  Select video mode [0]
  79.                                0 - 320x200 with title screen
  80.                                1 - 320x200 without title screen
  81.                                2 - 360x144 full screen mode
  82.                                3 - 180x144 full screen mode
  83.                                4 - 256x200 with title screen
  84.                                5 - 256x200 without title screen
  85.                                Please note that modes 2-5 may not be
  86.                                compatible with your VGA card or monitor
  87. -background <filename>         Select .GIF file to use as background [VGB-
  88.                                DOS.GIF] (Only works in video modes 0 and
  89.                                4)
  90. -sound <mode>                  Select sound mode [1]
  91.                                0 - No sound
  92.                                1 - Adlib
  93.                                You may want to have the sound turned off
  94.                                by default for certain games, as the
  95.                                emulation isn't nearly perfect
  96. -stereo <mode>                 Select stereo mode [1]
  97.                                0 - mono
  98.                                1 - normal
  99.                                2 - reversed
  100. -volume <value>                Select initial volume [10]. 0 is silent, 15
  101.                                is maximum. Volume control only works on
  102.                                SBPro or SB16 compatible cards
  103. -logsnd <filename>             Select sound log file [NULL]
  104. -color0 <name>                 Change color#0 [white]
  105. -color1 <name>                 Change color#1 [#B0B0B0]
  106. -color2 <name>                 Change color#2 [#606060]
  107. -color3 <name>                 Change color#3 [black]
  108. -backgroundcolorX              Same as -colorX, but only changes the
  109. -spritecolorX                  background/sprite/window colors
  110. -windowcolorX
  111. -colorscheme <scheme>          Select a pre-defined or user-defined color
  112.                                scheme [0].
  113.                                Currently pre-defined color schemes are:
  114.                                0 - Gray
  115.                                1 - Green
  116.                                2 - Yellow/Blue
  117.                                3 - High contrast green
  118.                                4 - Yellow
  119.                                5 - Amber
  120. -backgroundcolorscheme         Select background/sprite/window color
  121. -spritecolorscheme             scheme
  122. -windowcolorscheme
  123. -definecolorscheme <c0> <c1>   Define a color scheme. Color schemes 0 to
  124. <c2> <c3>                      127 are reserved, schemes 128 to 255 can be
  125.                                defined
  126. -brightness <value>            Select image brightness [0]
  127.                                -100 - Darkest  100 - Brightest
  128. -backgroundbrightness          Select background/sprite/window brightness
  129. -spritebrightness
  130. -windowbrightness
  131. -swapbuttons <flags>           Select buttons to swap [0]
  132.                                1 - Swap joystick buttons
  133.                                2 - Swap keyboard buttons
  134.                                3 - Swap both
  135. -autoa <mode>                  Select button A autofire mode [0] 0 - No
  136.                                autofire 1 - Autofire
  137. -autob <mode>                  Select button B autofire mode [0] 0 - No
  138.                                autofire 1 - Autofire
  139. -keys <string>                 Alter key mappings
  140. Some command line options may be abbreviated. You can get a list of
  141. supported abbreviations by using the -help command line option
  142.  
  143. Color names supported
  144. =====================
  145. The following color names can be used with the -colorX options: black,
  146. blue, green, cyan, red, magenta, brown, gray, dkgray, dkblue, dkgreen,
  147. dkcyan, dkred, dkmagenta, yellow, orange, pink, white. You can also
  148. specify an RGB value with #RRGGBB, e.g. -color0 #AA0055 will set color 0
  149. to brown.
  150.  
  151. Soundtrack file format
  152. ======================
  153. The soundtrack file format is as follows:
  154. Header:
  155. string         `GameBoy Soundtrack File 1.1',0x1A
  156. dword          Number of cycles per second
  157. 60 bytes       Reserved (0)
  158. Data:
  159. 0xFF <dword>   Number of cycles passed since last log
  160. 0xFE <word>    ...
  161. 0xFD <byte>    ...
  162. 0xF0           End track
  163. 0x00-0x16      Sound register write. Second byte is the value to write
  164. word=16-bit unsigned integer, LSB first
  165. dword=32-bit unsigned integer, LSB first
  166.  
  167. Configuration files
  168. ===================
  169. The emulator loads two configuration files (if present) before it loads a
  170. cartridge rom: VGB-DOS.CFG located in the emulator's directory and
  171. CART.CFG (e.g. DKONG.CFG if you load DKONG.GB) located in the cartridge
  172. dump's directory. These are plain text files containing optional command
  173. line options. Options can be separated with spaces, tabs or returns.
  174.  
  175. Troubleshooting
  176. ===============
  177. -  If the emulator refuses to load your ROM images, check if it's CRC is
  178.    correct and if it's size is a multiple of 8192 bytes. If it's CRC is
  179.    incorrect, you might want to try using -nocrc, although getting a
  180.    correct image is prefered. If it's size is incorrect, there might be a
  181.    SmartCard header attached to the file. Try stripping the first 512
  182.    bytes
  183. -  If a game doesn't run correctly, try increasing vperiod to about 100000
  184. -  If display is incorrect, try -nodelay or -uperiod 1
  185.  
  186. History
  187. =======
  188. 0.8b1   Fixed LCD state and serial I/O emulation, implemented sprite
  189.         priorities and improved sprite refreshing, added autofire options,
  190.         soundtrack can now be saved into a file, key mappings can now be
  191.         changed, increased speed
  192. 0.6.2   Fixed a major bug in the GB's timer interrupt scheme and a minor
  193.         bug in the RAM page allocation scheme
  194. 0.6.1   Fixed lots of bugs, added sprite color control
  195. 0.5.2   Major speedup, added sync option, fixed some bugs, added color
  196.         scheme support and a few other options
  197. 0.5.1   Initial release
  198.  
  199. Credits
  200. =======
  201. - The GIF decoding routines and the title GIF itself were taken from Jeff
  202.   Frohwein's code. Jeff also helped fixing lots of bugs in the emulator.
  203.   Thanks Jeff!
  204. - VGB-DOS was compiled using DJ Delorie's DJGPP v2.0. DJGPP is a 32 bit C
  205.   compiler for MS-DOS. Source code and binaries of DJGPP are available at
  206.   http://www.delorie.com.
  207.  
  208. Please send your comments to Marcel at
  209. m.dekogel@student.utwente.nl
  210. BUT PLEASE, DO NOT ASK FOR ROM IMAGES!
  211.